<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxQueryFilterData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structPxQueryFilterData.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPxQueryFilterData-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxQueryFilterData Struct Reference<div class="ingroups"><a class="el" href="group__scenequery.html">Scenequery</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Scene query filtering data.  
 <a href="structPxQueryFilterData.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxQueryFiltering_8h_source.html">PxQueryFiltering.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxQueryFilterData:</div>
<div class="dyncontent">
<div class="center"><img src="structPxQueryFilterData__coll__graph.png" border="0" usemap="#PxQueryFilterData_coll__map" alt="Collaboration graph"/></div>
<map name="PxQueryFilterData_coll__map" id="PxQueryFilterData_coll__map">
<area shape="rect" id="node2" href="classPxFlags.html" title="PxFlags\&lt; PxQueryFlag\l::Enum, PxU16 \&gt;" alt="" coords="5,5,164,47"/>
<area shape="rect" id="node3" href="structPxFilterData.html" title="PxFilterData is user&#45;definable data which gets passed into the collision filtering shader and/or call..." alt="" coords="188,13,283,39"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a589e393317001f2effd196324ee459ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryFilterData.html#a589e393317001f2effd196324ee459ed">PxQueryFilterData</a> ()</td></tr>
<tr class="memdesc:a589e393317001f2effd196324ee459ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor  <a href="#a589e393317001f2effd196324ee459ed">More...</a><br /></td></tr>
<tr class="separator:a589e393317001f2effd196324ee459ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6cb7f49fa427d80df37f02cae89a6679"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryFilterData.html#a6cb7f49fa427d80df37f02cae89a6679">PxQueryFilterData</a> (const <a class="el" href="structPxFilterData.html">PxFilterData</a> &amp;fd, <a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a> f)</td></tr>
<tr class="memdesc:a6cb7f49fa427d80df37f02cae89a6679"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor to set both filter data and filter flags  <a href="#a6cb7f49fa427d80df37f02cae89a6679">More...</a><br /></td></tr>
<tr class="separator:a6cb7f49fa427d80df37f02cae89a6679"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23e3e236a9bb2f49556421d24fbf253"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryFilterData.html#ac23e3e236a9bb2f49556421d24fbf253">PxQueryFilterData</a> (<a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a> f)</td></tr>
<tr class="memdesc:ac23e3e236a9bb2f49556421d24fbf253"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor to set filter flags only  <a href="#ac23e3e236a9bb2f49556421d24fbf253">More...</a><br /></td></tr>
<tr class="separator:ac23e3e236a9bb2f49556421d24fbf253"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8a0359e9d009598fb7e09d7dfc375456"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxFilterData.html">PxFilterData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryFilterData.html#a8a0359e9d009598fb7e09d7dfc375456">data</a></td></tr>
<tr class="memdesc:a8a0359e9d009598fb7e09d7dfc375456"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filter data associated with the scene query.  <a href="#a8a0359e9d009598fb7e09d7dfc375456">More...</a><br /></td></tr>
<tr class="separator:a8a0359e9d009598fb7e09d7dfc375456"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02180ad928beb2e5d3d5caf4cc84f387"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxQueryFilterData.html#a02180ad928beb2e5d3d5caf4cc84f387">flags</a></td></tr>
<tr class="memdesc:a02180ad928beb2e5d3d5caf4cc84f387"><td class="mdescLeft">&#160;</td><td class="mdescRight">Filter flags (see <a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61" title="Flags typedef for the set of bits defined in PxQueryFlag. ">PxQueryFlags</a>)  <a href="#a02180ad928beb2e5d3d5caf4cc84f387">More...</a><br /></td></tr>
<tr class="separator:a02180ad928beb2e5d3d5caf4cc84f387"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Scene query filtering data. </p>
<p>Whenever the scene query intersects a shape, filtering is performed in the following order:</p>
<ul>
<li>For non-batched queries only:<br />
If the data field is non-zero, and the bitwise-AND value of data AND the shape's queryFilterData is zero, the shape is skipped </li>
<li>If filter callbacks are enabled in flags field (see <a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61" title="Flags typedef for the set of bits defined in PxQueryFlag. ">PxQueryFlags</a>) they will get invoked accordingly. </li>
<li>If neither <a class="el" href="structPxQueryFlag.html#a2124ff0cff0a021e01e6880a1bba431fa8afbf3ede02abfeef2a9e8d38f0b9a78" title="Run the pre-intersection-test filter (see PxQueryFilterCallback::preFilter()) ">PxQueryFlag::ePREFILTER</a> or <a class="el" href="structPxQueryFlag.html#a2124ff0cff0a021e01e6880a1bba431fa98ce80be9551f124bd882bdb83dafb7e" title="Run the post-intersection-test filter (see PxQueryFilterCallback::postFilter()) ">PxQueryFlag::ePOSTFILTER</a> is set, the hit defaults to type <a class="el" href="structPxQueryHitType.html#acab1ef408184995d169330ed689b79e3a60dc59a348d85c101747ed45d9b20750" title="a hit on the shape blocks the query (does not block overlap queries) ">PxQueryHitType::eBLOCK</a> when the value of <a class="el" href="structPxHitCallback.html#a549f6828e98c9aeaee9012defa100f74" title="Number of touching hits returned by the query. Used with PxHitBuffer. ">PxHitCallback::nbTouches</a> provided with the query is zero and to type <a class="el" href="structPxQueryHitType.html#acab1ef408184995d169330ed689b79e3aac7ebce08c20ff88ea4328035daa2498" title="a hit on the shape touches the intersection geometry of the query but does not block it ...">PxQueryHitType::eTOUCH</a> when <a class="el" href="structPxHitCallback.html#a549f6828e98c9aeaee9012defa100f74" title="Number of touching hits returned by the query. Used with PxHitBuffer. ">PxHitCallback::nbTouches</a> is positive.</li>
</ul>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxScene.html#a7d7dcd877cee092f8b57c67d79982b50" title="Performs a raycast against objects in the scene, returns results in a PxRaycastBuffer object or via a...">PxScene.raycast</a> <a class="el" href="classPxScene.html#a9b07b2a98e64105a06e97ffaeba2a63d" title="Performs a sweep test against objects in the scene, returns results in a PxSweepBuffer object or via ...">PxScene.sweep</a> <a class="el" href="classPxScene.html#a31d09c0e967f9806a1f0d5df78dfc996" title="Performs an overlap test of a given geometry against objects in the scene, returns results in a PxOve...">PxScene.overlap</a> <a class="el" href="classPxBatchQuery.html#a39f64da3f122ff78cbaa1a5a83bc9840" title="Performs a raycast against objects in the scene, returns results in PxBatchQueryMemory::userRaycastRe...">PxBatchQuery.raycast</a> <a class="el" href="classPxBatchQuery.html#abf15206e4dcf2238db75f47565078b49" title="Performs a sweep test against objects in the scene, returns results in PxBatchQueryMemory::userSweepR...">PxBatchQuery.sweep</a> <a class="el" href="classPxBatchQuery.html#a2312bc0c82e54bbf46c16e203f9937e3" title="Performs an overlap test of a given geometry against objects in the scene, returns results in PxBatch...">PxBatchQuery.overlap</a> <a class="el" href="structPxQueryFlag.html#a2124ff0cff0a021e01e6880a1bba431fa2837a6ac649b29ee72af661b65f4d8ab">PxQueryFlag::eANY_HIT</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a589e393317001f2effd196324ee459ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a589e393317001f2effd196324ee459ed">&#9670;&nbsp;</a></span>PxQueryFilterData() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxQueryFilterData::PxQueryFilterData </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>default constructor </p>

</div>
</div>
<a id="a6cb7f49fa427d80df37f02cae89a6679"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cb7f49fa427d80df37f02cae89a6679">&#9670;&nbsp;</a></span>PxQueryFilterData() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxQueryFilterData::PxQueryFilterData </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structPxFilterData.html">PxFilterData</a> &amp;&#160;</td>
          <td class="paramname"><em>fd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a>&#160;</td>
          <td class="paramname"><em>f</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>constructor to set both filter data and filter flags </p>

</div>
</div>
<a id="ac23e3e236a9bb2f49556421d24fbf253"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac23e3e236a9bb2f49556421d24fbf253">&#9670;&nbsp;</a></span>PxQueryFilterData() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxQueryFilterData::PxQueryFilterData </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a>&#160;</td>
          <td class="paramname"><em>f</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>constructor to set filter flags only </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8a0359e9d009598fb7e09d7dfc375456"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a0359e9d009598fb7e09d7dfc375456">&#9670;&nbsp;</a></span>data</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxFilterData.html">PxFilterData</a> PxQueryFilterData::data</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Filter data associated with the scene query. </p>

</div>
</div>
<a id="a02180ad928beb2e5d3d5caf4cc84f387"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02180ad928beb2e5d3d5caf4cc84f387">&#9670;&nbsp;</a></span>flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61">PxQueryFlags</a> PxQueryFilterData::flags</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Filter flags (see <a class="el" href="group__scenequery.html#gaacf083b040f6c841644782282171bd61" title="Flags typedef for the set of bits defined in PxQueryFlag. ">PxQueryFlags</a>) </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxQueryFiltering_8h_source.html">PxQueryFiltering.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structPxQueryFilterData.html">PxQueryFilterData</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
